<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Voro++: voro::particle_order Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Voro++
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>voro</b>      </li>
      <li class="navelem"><a class="el" href="classvoro_1_1particle__order.html">particle_order</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">voro::particle_order Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="voro::particle_order" -->
<p>A class for storing ordering information when particles are added to a container.  
 <a href="classvoro_1_1particle__order.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#a205b5e4a472043123d091b1a3bc103c8">particle_order</a> (int init_size=init_ordering_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#aec68354015eedbde68752a58a8457c90">~particle_order</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#adabcf6cd995eb03fe007844ba5637a8a">add</a> (int ijk, int q)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#af8bef46cbdfdee608090aa5df0666df2">o</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#a6aeb89179930977f344416a0ba1c38a4">op</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1particle__order.html#a742bc941dfd87ecd64b42f6e50df19db">size</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>When particles are added to a container class, they are sorted into an internal computational grid of blocks. The <a class="el" href="classvoro_1_1particle__order.html" title="A class for storing ordering information when particles are added to a container.">particle_order</a> class provides a mechanism for remembering which block particles were sorted into. The import and put routines in the container class have variants that also take a <a class="el" href="classvoro_1_1particle__order.html" title="A class for storing ordering information when particles are added to a container.">particle_order</a> class. Each time they are called, they will store the block that the particle was sorted into, plus the position of the particle within the block. The <a class="el" href="classvoro_1_1particle__order.html" title="A class for storing ordering information when particles are added to a container.">particle_order</a> class can used by the <a class="el" href="classvoro_1_1c__loop__order.html" title="Class for looping over all of the particles specified in a pre-assembled particle_order class...">c_loop_order</a> class to specifically loop over the particles that have their information stored within it. </p>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00043">43</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a205b5e4a472043123d091b1a3bc103c8"></a><!-- doxytag: member="voro::particle_order::particle_order" ref="a205b5e4a472043123d091b1a3bc103c8" args="(int init_size=init_ordering_size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">voro::particle_order::particle_order </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>init_size</em> = <code>init_ordering_size</code></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="classvoro_1_1particle__order.html" title="A class for storing ordering information when particles are added to a container.">particle_order</a> constructor allocates memory to store the ordering information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">init_size</td><td>the initial amount of memory to allocate. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00057">57</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<a class="anchor" id="aec68354015eedbde68752a58a8457c90"></a><!-- doxytag: member="voro::particle_order::~particle_order" ref="aec68354015eedbde68752a58a8457c90" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">voro::particle_order::~particle_order </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="classvoro_1_1particle__order.html" title="A class for storing ordering information when particles are added to a container.">particle_order</a> destructor frees the dynamically allocated memory used to store the ordering information. </p>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00061">61</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adabcf6cd995eb03fe007844ba5637a8a"></a><!-- doxytag: member="voro::particle_order::add" ref="adabcf6cd995eb03fe007844ba5637a8a" args="(int ijk, int q)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void voro::particle_order::add </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ijk</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>q</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Adds a record to the order, corresponding to the memory address of where a particle was placed into the container. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ijk</td><td>the block into which the particle was placed. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">q</td><td>the position within the block where the particle was placed. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00069">69</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="af8bef46cbdfdee608090aa5df0666df2"></a><!-- doxytag: member="voro::particle_order::o" ref="af8bef46cbdfdee608090aa5df0666df2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int* <a class="el" href="classvoro_1_1particle__order.html#af8bef46cbdfdee608090aa5df0666df2">voro::particle_order::o</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>A pointer to the array holding the ordering. </p>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00046">46</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a6aeb89179930977f344416a0ba1c38a4"></a><!-- doxytag: member="voro::particle_order::op" ref="a6aeb89179930977f344416a0ba1c38a4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int* <a class="el" href="classvoro_1_1particle__order.html#a6aeb89179930977f344416a0ba1c38a4">voro::particle_order::op</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>A pointer to the next position in the ordering array in which to store an entry. </p>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00049">49</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a742bc941dfd87ecd64b42f6e50df19db"></a><!-- doxytag: member="voro::particle_order::size" ref="a742bc941dfd87ecd64b42f6e50df19db" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classvoro_1_1particle__order.html#a742bc941dfd87ecd64b42f6e50df19db">voro::particle_order::size</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The current memory allocation for the class, set to the number of entries which can be stored. </p>

<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00052">52</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="c__loops_8hh_source.html">c_loops.hh</a></li>
<li><a class="el" href="c__loops_8cc_source.html">c_loops.cc</a></li>
</ul>
</div>


<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 23 2011 22:49:07 for Voro++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
